home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 050 / xrf.arc / XRF.DOC < prev    next >
Encoding:
Text File  |  1986-03-11  |  5.8 KB  |  172 lines
  1. TITLE
  2.  
  3.     xrf    Cross-Reference Lister for C Programs
  4.  
  5. AUTHOR
  6.  
  7.   Written By:
  8.                Bob Denny
  9.                Creative System Design Co.
  10.                3452 E. Foothill Blvd. << Suite 601 >>
  11.                Pasadena, Ca.  91107
  12.                (213) 355-6836
  13.  
  14.   Modified for MSDOS By:
  15.  
  16.         Mike Cole
  17.         Digital Equipment Co.
  18.         PC Customer Information & Support Centre,
  19.         Jays Close,
  20.         Basingstoke,
  21.         Hampshire  RG22 4DE,
  22.         ENGLAND.        (44) 256-59200
  23. SYNOPSIS
  24.  
  25.     xrf [-options] [-o outfile] [file ...] [file...]
  26.  
  27. DESCRIPTION
  28.  
  29.     xrf prepares a cross-reference listing for C source programs. 
  30.     It runs asis on any MSDOS V2.00 or later system. 
  31.  
  32.     The following options are defined:
  33.  
  34.     -n    Narrow output (80 columns).  The default is 132 columns.
  35.     -i    Symbol size is 31, else truncated to 8 characters (default).
  36.     -s    Spool output to the default line printer.
  37.     -p    Print C source (with linenumbers)
  38.     -f    Process functions only, else do all symbols.
  39.     -c    Concatanate input files(s). The default is seperate reference
  40.         listings for each file.
  41.     -v    verbose mode
  42.  
  43.     -o file    Write output to the named file.  The default is the first input
  44.         file encountered, with a filetype (extension) of ".REF".
  45.  
  46.     [file]  Name(s) of C programs. xrf accepts wild-card file input.
  47.         The '.c' suffix is provided automatically. 
  48.  
  49.  
  50. NOTES
  51.  
  52.   1.  Input files may have wild-card names.
  53.   2.  File Specifications are stated WITHOUT AN EXTENSION. 
  54.       An INPUT extension ".C" is added automatically.
  55.       An OUTPUT extension ".REF" is added automatically.
  56.   3.  If the -o option is not used, an output filename is constructed
  57.       as "<first_input_file>.xrf".
  58.   4.  Logical names can be used for output, E.G. "-o con" will output direct
  59.       to the console (screen).
  60.   5.  For the spool option to work, the MSDOS "PRINT" command must have 
  61.       been used previously. EG PRINT<c/r> will just establish the
  62.       resident print spooler.
  63.   6.  For those of us who use later versions of Computer Innovations, XRF
  64.       also recognises the Environment string C86TEMP as a path for any
  65.       work files. The most common usage is a drive specifier of the memory
  66.       drive to speed run time, eg <SET C86TEMP = F:>. The READ.ME file of 
  67.       CI86 v2.20m give a reasonable explanation.
  68.  
  69. HISTORY
  70.  
  71.   Experimental Version                          X1.0             5-May-80
  72.   Split off initialization                      X1.1             7-May-80
  73.   Prototype.                                    Y1.2             9-May-80
  74.   Release.                                      V1.3             9-May-80
  75.   Chg. for DECUS OTS. & Cmplr.                  V1.4             1-Jul-80
  76.   Add support for RT-11                         V1.5             3-Jul-80
  77.   Conditionalized spool call            V1.6 MM         9-Jul-80
  78.   Added narrow, outfile, etc.            V1.7 MM        10-Jul-80
  79.   Added multiple infiles            V1.8 MM        22-Jul-80
  80.   Fspool now in the library            V1.9 MM         2-Aug-80
  81.   MSDOS version                    V1.10MC        13-Jan-85
  82.   Rainbow Msdos version (CI86)          V1.14 MC        12-Jan-85
  83.    . print spooling -s option
  84.    . c,v,i options
  85.    . identify procedure
  86.    . Remove case sensitive printing order
  87.   Tidy up                               V1.15 MC        26-Jan-85
  88.    . fix loop on #endif
  89.    . identify #include file
  90.   More tidying                          V1.16MC        29-Mar-85
  91.    . Fix file close problem[XRF0] 
  92.    . add -f option
  93.    . rewrite memory allocation algorithm for Rainbow.
  94.   Major surgery                         V1.17MC         4-Apr-85
  95.    . transform tree storage to polyphase sort
  96.      to give unlimited number of references.
  97.    . Make -V more verbose.
  98.   Pack workfile records to use less diskspace.    V1.18MC        14-Apr-85
  99.   Recompile version 2.20m.            V2.00MC        26-Apr-85
  100.    . Fix memory FREE pb.
  101.    . Add C86TEMP path pickup.
  102.  
  103.  
  104. DIAGNOSTICS
  105.  
  106.         CAUSE:                                  MESSAGE:
  107.     xrf ran out of main memory space.    Trying to get too much.
  108.                         Internal error, get help.
  109.                         Not enough memory space.
  110.     Specified file not found.        Cannot open "file"
  111.                         Cannot open output file "file"
  112.     Parameter error.            Useage ...
  113.         PRINT spooler not started or queue    Cannot queue nnnnnnnn.REF
  114.     full.
  115.  
  116. OUTPUT FORMAT
  117.  
  118. Field
  119. 1 Symbol            8 chars (30 if -i option active) truncated if
  120.                 longer. Symbols appear in the case they were
  121.                 entered but in order.
  122.                 Symbol()             indicates function.
  123.                 "Symbol" or <Symbol> indicates #include file.
  124.  
  125. 2 Program name            Only present for -c option. Matching references
  126.                 are grouped togethor but printed showing source
  127.                 file name.
  128.  
  129. 3 References            As many as will fit onto a 132 character print
  130.                 line (unless -n option, then 80 character line.
  131.  
  132. BUGS
  133.  
  134. None known (I hope).
  135.  
  136. CREATING FROM SOURCES
  137.  
  138. To Create DECUSC Cross Referencer using Computer Innovations C Compiler 
  139. version 2.20m a batch file CXRF.BAT has been provided which will extract 
  140. all files from the Archive file XRF.ARC. If you alter sources afterwards, 
  141. you can use LXRF.BAT to relink.
  142.  
  143. CXRF has two parameters: 1 = path for CIC "stdio.h" file.
  144.                          2 = path for CIC "c86s2s.lib" file (small model only).
  145.  
  146. Example of use is:-  CXRF \cic\h\ \CIC\LIB\
  147.  
  148. Messages you should see:-
  149.  
  150.     Create DECUSC Cross Referencer using Computer Innovations C Compiler
  151.     Compiling XRF0 ....
  152.     Compiling XRF1 ....
  153.     Compiling XRF2 ....
  154.     Compiling XRF3 ....
  155.     Compiling XRFD ....
  156.     Compiling XRFR ....
  157.     Compiling SPOOL ...
  158.     linking XRF .......
  159.  
  160. Things that can go wrong:-
  161.  
  162.    1    stdio.h path wrong <%1stdio.h>
  163.     Compile of XRF failed.                Parameter 1 wrong
  164.  
  165.    2    library path wrong <%2c86s2s.lib>
  166.     Compile of XRF failed.                Parameter 2 wrong
  167.  
  168.    3    Compile of XRF failed.                Error in last action.
  169.                             Check source files and
  170.                             compiler version. Also
  171.                             see the .LST files.
  172.